2.2 Consultar dependentes

Request

Request

query Dependents {
  dependents(skip: 0, take: 1) {
    items {
      id
      name
      refId
      cpf
      customFields {
        id
        customFieldId
        personId
        content
      }
      classAssignments {
        academicClassId
        academicLevelId
        academicSerieId
        academicYearId
        situation
        id
        refId
      }
      enrollments {
        registry
        situation
        id
        refId
      }
    }
  }
}

Params

Parâmetro	Tipo	Descrição
skip	Int	Número de registros a serem puladas no início da coleção. Utilizado para paginação.
take	Int	Número máximo de registros a serem retornados. Utilizado para paginação.
where	DependentFilterInput	Objeto que define os critérios de filtragem para os dependentes.
order	[DependentSortInput!]	Array de objetos que definem a ordem de classificação dos resultados.

Objeto DependentFilterInput

Campo	Tipo	Descrição
active	BooleanOperationFilterInput	Status de ativação
address	AddressFilterInput	Dados do endereço
and	[DependentFilterInput!]
apiRequestLogs	ListFilterInputTypeOfApiRequestLogFilterInput
changes	ListFilterInputTypeOfLogHistoryFilterInput	Histórico de alterações
classAssignments	ListFilterInputTypeOfClassAssignmentFilterInput	Dados das enturmações
company	CompanyFilterInput	Dados da empresa
companyId	IntOperationFilterInput	Id da empresa
cpf	StringOperationFilterInput	CPF
creationDate	DateTimeOperationFilterInput	Data de criação
customFields	ListFilterInputTypeOfCustomFieldContentFilterInput	Dados dos campos customizáveis
deleted	BooleanOperationFilterInput	Status de deleção
email	StringOperationFilterInput	Email
enrollments	ListFilterInputTypeOfEnrollmentFilterInput	Dados das matrículas
externalId	IntOperationFilterInput	Id externo
financialOwners	ListFilterInputTypeOfFinancialOwnerFilterInput	Dados dos responsáveis financeiros
graphQLRequestLogs	ListFilterInputTypeOfGraphQLRequestLogFilterInput
id	IntOperationFilterInput	Id do objeto da requisição
name	StringOperationFilterInput	Nome
or	[DependentFilterInput!]
paymentPlans	ListFilterInputTypeOfPaymentPlanFilterInput	Dados dos planos de pagamento
refId	UuidOperationFilterInput	Id da referência

Objeto DependentSortInput

Campo	Tipo	Descrição
active	SortEnumType	Define a ordem de classificação para o campo "Status de Ativação".
address	AddressSortInput	Define a ordem de classificação para os dados do endereço.
company	CompanySortInput	Define a ordem de classificação para os dados da empresa.
companyId	SortEnumType	Define a ordem de classificação para o campo "Id da Empresa".
cpf	SortEnumType	Define a ordem de classificação para o campo "CPF".
creationDate	SortEnumType	Define a ordem de classificação para o campo "Data de Criação".
deleted	SortEnumType	Define a ordem de classificação para o campo "Status de Deleção".
email	SortEnumType	Define a ordem de classificação para o campo "Email".
externalId	SortEnumType	Define a ordem de classificação para o campo "Id Externo".
id	SortEnumType	Define a ordem de classificação para o campo "Id do objeto da Requisição".
name	SortEnumType	Define a ordem de classificação para o campo "Nome".
refId	SortEnumType	Define a ordem de classificação para o campo "Id da Referência".

Response

Response

{
  "data": {
    "dependents": {
      "items": [
        {
          "id": 49,
          "name": "Aluno TEste",
          "refId": "39a65c33-6b2d-4b44-84e0-072ea92b026b",
          "cpf": null,
          "customFields": [
            {
              "id": 73,
              "customFieldId": 1,
              "personId": 49,
              "content": "1231250"
            },
            {
              "id": 74,
              "customFieldId": 2,
              "personId": 49,
              "content": "1° Ano"
            }
          ],
          "classAssignments": [],
          "enrollments": []
        }
      ]
    }
  }
}

Result

Campo	Tipo	Descrição
dependents	DependentsCollectionSegment	Coleção de dependentes

Objeto DependentsColletionSegment

Campo	Tipo	Descrição
items	[Dependent!]	Lista de objetos do tipo "Dependent".
pageInfo	CollectionSegmentInfo!	Informações para auxiliar na paginação dos resultados.
totalCount	Int!	Número total de registros encontrados, independentemente da paginação.